Developer CD Series 1995 June: Reference Library/Dev.CD Jun 95/Dev.CD Jun 95.toast/What's New?/New System Software Extensions/QuickDraw 3D ß/Programming/Interfaces/QD3DPick.h

C/C++ Source or Header | 1995-04-04 | 9.6 KB | 369 lines | [TEXT/MPS ]

/******************************************************************************
 **                                                                             **
 **     Module:        QD3DPick.h                                                 **
 **                                                                          **
 **                                                                          **
 **     Purpose:     Public picking routines                                  **
 **                                                                          **
 **                                                                          **
 **                                                                          **
 **     Copyright (C) 1992-1994 Apple Computer, Inc.  All rights reserved.     **
 **                                                                          **
 **                                                                          **
 *****************************************************************************/
#ifndef QD3DPick_h
#define QD3DPick_h

#if PRAGMA_ONCE
    #pragma once
#endif

#include "QD3DStyle.h"
#include "QD3DGeometry.h"

#ifdef __cplusplus
extern "C" {
#endif  /*  __cplusplus  */


/*****************************************************************************
 **                                                                            **
 **                            Mask bits for hit information                     **
 **                                                                            **
 *****************************************************************************/

typedef enum TQ3PickDetailMasks {
    kQ3PickDetailNone                    = 0,
    kQ3PickDetailMaskPickID             = 1 << 0,
    kQ3PickDetailMaskPath                 = 1 << 1,
    kQ3PickDetailMaskObject             = 1 << 2,
    kQ3PickDetailMaskLocalToWorldMatrix    = 1 << 3,
    kQ3PickDetailMaskXYZ                 = 1 << 4,
    kQ3PickDetailMaskDistance             = 1 << 5,
    kQ3PickDetailMaskNormal             = 1 << 6,
#if defined(ESCHER_VER_15) && (ESCHER_VER_15)
    kQ3PickDetailMaskShapePart             = 1 << 7,
    kQ3PickDetailMaskUV                 = 1 << 8,
    kQ3PickDetailMaskNeighborhood        = 1 << 9
#else
    kQ3PickDetailMaskShapePart             = 1 << 7
#endif  /*  ESCHER_VER_15  */
} TQ3PickDetailMasks;

typedef unsigned long TQ3PickDetail;


/******************************************************************************
 **                                                                             **
 **                                Hitlist sorting                                 **
 **                                                                             **
 *****************************************************************************/

typedef enum TQ3PickSort {
    kQ3PickSortNone,
    kQ3PickSortNearToFar,
    kQ3PickSortFarToNear
} TQ3PickSort;


/******************************************************************************
 **                                                                             **
 **                    Data structures to set up the pick object                 **
 **                                                                             **
 *****************************************************************************/

#define kQ3ReturnAllHits        0

typedef struct TQ3PickData {
    TQ3PickSort            sort;
    TQ3PickDetail        mask;
    unsigned long        numHitsToReturn;
} TQ3PickData;

typedef struct TQ3WindowPointPickData {
    TQ3PickData            data;
    TQ3Point2D            point;
    float                vertexTolerance;
    float                edgeTolerance;
} TQ3WindowPointPickData;

typedef struct TQ3WindowRectPickData {
    TQ3PickData            data;
    TQ3Area                rect;
} TQ3WindowRectPickData;


/******************************************************************************
 **                                                                             **
 **                                    Hit data                                 **
 **                                                                             **
 *****************************************************************************/

typedef struct TQ3HitPath {
    unsigned long             depth;
    TQ3GroupPosition            *positions;
} TQ3HitPath;

typedef struct TQ3HitData {
    TQ3PickParts                part;
    TQ3PickDetail            validMask;
    unsigned long             pickID;
    struct TQ3HitPath        path;
    TQ3Object                object;
    TQ3Matrix4x4                localToWorldMatrix;
    TQ3Point3D                xyzPoint;
    float                    distance;
    TQ3Vector3D                normal;
    TQ3ShapePartObject        shapePart;
} TQ3HitData;


/******************************************************************************
 **                                                                             **
 **                                Pick class methods                             **
 **                                                                             **
 *****************************************************************************/

EXPORT TQ3ObjectType Q3Pick_GetType(
    TQ3PickObject        pick);

EXPORT TQ3Status Q3Pick_GetData(
    TQ3PickObject        pick,
    TQ3PickData            *data);

EXPORT TQ3Status Q3Pick_SetData(
    TQ3PickObject        pick,
    const TQ3PickData    *data);

EXPORT TQ3Status Q3Pick_GetVertexTolerance(
    TQ3PickObject        pick,
    float                *vertexTolerance);

EXPORT TQ3Status Q3Pick_GetEdgeTolerance(
    TQ3PickObject        pick,
    float                *edgeTolerance);

EXPORT TQ3Status Q3Pick_SetVertexTolerance(
    TQ3PickObject        pick,
    float                vertexTolerance);

EXPORT TQ3Status Q3Pick_SetEdgeTolerance(
    TQ3PickObject        pick,
    float                edgeTolerance);


EXPORT TQ3Status Q3Pick_GetNumHits(
    TQ3PickObject        pick,
    unsigned long        *numHits);

EXPORT TQ3Status Q3Pick_GetHitData(
    TQ3PickObject        pick,
    unsigned long        index,
    TQ3HitData            *hitData);

EXPORT TQ3Status Q3Hit_EmptyData(
    TQ3HitData            *hitData);

EXPORT TQ3Status Q3Pick_EmptyHitList(
    TQ3PickObject        pick);


/******************************************************************************
 **                                                                             **
 **                            Window point pick methods                         **
 **                                                                             **
 *****************************************************************************/

EXPORT TQ3PickObject Q3WindowPointPick_New(
    const TQ3WindowPointPickData    *data);

EXPORT TQ3Status Q3WindowPointPick_GetPoint(
    TQ3PickObject                    pick,
    TQ3Point2D                        *point);

EXPORT TQ3Status Q3WindowPointPick_SetPoint(
    TQ3PickObject                    pick,
    const TQ3Point2D                *point);

EXPORT TQ3Status Q3WindowPointPick_GetData(
    TQ3PickObject                    pick,
    TQ3WindowPointPickData            *data);

EXPORT TQ3Status Q3WindowPointPick_SetData(
    TQ3PickObject                    pick,
    const TQ3WindowPointPickData    *data);


/******************************************************************************
 **                                                                             **
 **                            Window rect pick methods                         **
 **                                                                             **
 *****************************************************************************/

EXPORT TQ3PickObject Q3WindowRectPick_New(
    const TQ3WindowRectPickData    *data);

EXPORT TQ3Status Q3WindowRectPick_GetRect(
    TQ3PickObject                pick,
    TQ3Area                        *rect);

EXPORT TQ3Status Q3WindowRectPick_SetRect(
    TQ3PickObject                pick,
    const TQ3Area                *rect);

EXPORT TQ3Status Q3WindowRectPick_GetData(
    TQ3PickObject                pick,
    TQ3WindowRectPickData        *data);

EXPORT TQ3Status Q3WindowRectPick_SetData(
    TQ3PickObject                pick,
    const TQ3WindowRectPickData    *data);


#if defined(ESCHER_VER_15) && ESCHER_VER_15

/******************************************************************************
 **                                                                             **
 **                    Data structures to set up the pick object                 **
 **                                                                             **
 *****************************************************************************/

typedef struct TQ3BoxPickData {
    TQ3PickData            data;
    TQ3BoundingBox        box;
} TQ3BoxPickData;

typedef struct TQ3RayPickData {
    TQ3PickData            data;
    TQ3Ray3D                ray;
    float                vertexTolerance;
    float                edgeTolerance;
} TQ3RayPickData;

typedef struct TQ3SpherePickData {
    TQ3PickData            data;
    TQ3BoundingSphere    sphere;
    float                vertexTolerance;
    float                edgeTolerance;
} TQ3SpherePickData;


/******************************************************************************
 **                                                                             **
 **                        World-space box pick methods                         **
 **                                                                             **
 *****************************************************************************/

EXPORT TQ3PickObject Q3BoxPick_New(
    const TQ3BoxPickData    *data);

EXPORT TQ3Status Q3BoxPick_GetBox(
    TQ3PickObject        pick,
    TQ3BoundingBox        *box);

EXPORT TQ3Status Q3BoxPick_SetBox(
    TQ3PickObject        pick,
    const TQ3BoundingBox    *box);

EXPORT TQ3Status Q3BoxPick_GetData(
    TQ3PickObject        pick,
    TQ3BoxPickData        *data);

EXPORT TQ3Status Q3BoxPick_SetData(
    TQ3PickObject        pick,
    const TQ3BoxPickData    *data);


/******************************************************************************
 **                                                                             **
 **                        World-space ray pick methods                         **
 **                                                                             **
 *****************************************************************************/

EXPORT TQ3PickObject Q3RayPick_New(
    const TQ3RayPickData    *data);

EXPORT TQ3Status Q3RayPick_GetRay(
    TQ3PickObject        pick,
    TQ3Ray3D                *ray);

EXPORT TQ3Status Q3RayPick_SetRay(
    TQ3PickObject        pick,
    const TQ3Ray3D        *ray);

EXPORT TQ3Status Q3RayPick_GetData(
    TQ3PickObject        pick,
    TQ3RayPickData        *data);

EXPORT TQ3Status Q3RayPick_SetData(
    TQ3PickObject        pick,
    const TQ3RayPickData    *data);


/******************************************************************************
 **                                                                             **
 **                        World-space sphere pick methods                         **
 **                                                                             **
 *****************************************************************************/

EXPORT TQ3PickObject Q3SpherePick_New(
    const TQ3SpherePickData    *data);

EXPORT TQ3Status Q3SpherePick_GetSphere(
    TQ3PickObject            pick,
    TQ3BoundingSphere        *sphere);

EXPORT TQ3Status Q3SpherePick_SetSphere(
    TQ3PickObject            pick,
    const TQ3BoundingSphere    *sphere);

EXPORT TQ3Status Q3SpherePick_GetData(
    TQ3PickObject            pick,
    TQ3SpherePickData        *data);

EXPORT TQ3Status Q3SpherePick_SetData(
    TQ3PickObject            pick,
    const TQ3SpherePickData    *data);


/******************************************************************************
 **                                                                             **
 **                                Shape Part methods                             **
 **                                                                             **
 *****************************************************************************/

EXPORT TQ3ObjectType Q3ShapePart_GetType(
    TQ3ShapePartObject            shapePartObject);

EXPORT TQ3ObjectType Q3MeshPart_GetType(
    TQ3MeshPartObject            meshPartObject);

EXPORT TQ3Status Q3ShapePart_GetShape(
    TQ3ShapePartObject            shapePartObject,
    TQ3ShapeObject                *shapeObject);

EXPORT TQ3Status Q3MeshPart_GetComponent(
    TQ3MeshPartObject            meshPartObject,
    TQ3MeshComponent                *component);

EXPORT TQ3Status Q3MeshFacePart_GetFace(
    TQ3MeshFacePartObject        meshFacePartObject,
    TQ3MeshFace                    *face);

EXPORT TQ3Status Q3MeshEdgePart_GetEdge(
    TQ3MeshEdgePartObject        meshEdgePartObject,
    TQ3MeshEdge                    *edge);

EXPORT TQ3Status Q3MeshVertexPart_GetVertex(
    TQ3MeshVertexPartObject        meshVertexPartObject,
    TQ3MeshVertex                *vertex);


#endif    /* ESCHER_VER_15 */

#ifdef __cplusplus
}
#endif  /*  __cplusplus  */

#endif  /*  QD3DPick_h  */